HealthActivitySummary#

The HealthActivitySummary class provides an interface for accessing daily summaries of user activity as recorded by the Apple Health system. This includes move, exercise, and stand metrics, and optionally supports both energy-based and time-based activity move goals.

This class is useful for apps that aim to present a user's daily activity rings or generate daily fitness reports.

Use Cases#

• Displaying daily activity ring progress (Move, Exercise, Stand)
• Comparing user activity against daily goals
• Building custom health dashboards and fitness visualizations
• Providing trend analysis or goal reminders

Class: HealthActivitySummary#

Properties#

Methods#

Each of the following methods returns a numeric value representing either the achieved metric or the goal for that metric on the specified date. All values are returned in the unit specified by the caller.

activeEnergyBurned(unit: HealthUnit): number#

Returns the amount of active energy burned for the day in the given unit (e.g., kilocalories).

activeEnergyBurnedGoal(unit: HealthUnit): number#

Returns the daily goal for active energy burned in the given unit.

Only valid when activityMoveMode is HealthActivityMoveMode.activeEnergy.

appleMoveTime(unit: HealthUnit): number#

Returns the duration of movement (in minutes or seconds) tracked by the Apple Watch's move time mode.

appleMoveTimeGoal(unit: HealthUnit): number#

Returns the goal for move time on the current day.

Only valid when activityMoveMode is HealthActivityMoveMode.appleMoveTime.

appleExerciseTime(unit: HealthUnit): number#

Returns the total time spent in exercise (typically in minutes), as measured by the Apple Watch.

appleExerciseTimeGoal(unit: HealthUnit): number#

Returns the exercise time goal for the current day.

appleStandHours(unit: HealthUnit): number#

Returns the number of hours in which the user stood and moved for at least one minute.

appleStandHoursGoal(unit: HealthUnit): number#

Returns the user's stand hours goal for the day (typically 12).

Example Usage#

1async function showTodaySummary() {
2  const startDate = new Date()
3  startDate.setHours(0, 0, 0, 0)
4
5  const start = DateComponents.fromDate(startDate)
6  const end = DateComponents.fromDate(startDate)
7  end.date += 1
8
9  const summaries = await Health.queryActivitySummaries({
10    start, // today
11    end,
12  })
13
14  if (summaries.length === 0) {
15    console.log('No activity summary available for today.')
16    return
17  }
18
19  const summary = summaries[0]
20
21  console.log('Date:', summary.dateComponents)
22  console.log('Move Mode:', summary.activityMoveMode)
23
24  const kcal = summary.activeEnergyBurned(HealthUnit.kilocalorie())
25  const kcalGoal = summary.activeEnergyBurnedGoal(HealthUnit.kilocalorie())
26
27  console.log(`Active Energy Burned: ${kcal} / ${kcalGoal} kcal`)
28  console.log(`Exercise Time: ${summary.appleExerciseTime(HealthUnit.minute())} min`)
29  console.log(`Stand Hours: ${summary.appleStandHours(HealthUnit.count())} hr`)
30}

Notes#

• HealthActivitySummary does not store historical trend data. Use multiple summaries to build a timeline.
• Depending on the user's Apple Watch settings, the move goal can be based on energy burned or move time.
• All returned values are numeric and can be formatted or converted further based on your needs.
• HealthUnit must match the type of data requested. For time-based values, use HealthUnit.minute() or HealthUnit.second(). For count-based values like stand hours, use HealthUnit.count().